Skip to main content
POST
/
rag
Create RAG Config
curl --request POST \
  --url https://rag-prod.studio.lyzr.ai/v3/rag/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "<string>",
  "llm_credential_id": "<string>",
  "embedding_credential_id": "<string>",
  "vector_db_credential_id": "<string>",
  "collection_name": "<string>",
  "llm_model": "<string>",
  "embedding_model": "<string>",
  "vector_store_provider": "<string>",
  "description": "",
  "semantic_data_model": false,
  "meta_data": {}
}
'
{
  "id": "<string>",
  "user_id": "<string>",
  "llm_credential_id": "<string>",
  "embedding_credential_id": "<string>",
  "vector_db_credential_id": "<string>",
  "description": "<string>",
  "collection_name": "<string>",
  "llm_model": "<string>",
  "embedding_model": "<string>",
  "vector_store_provider": "<string>",
  "semantic_data_model": true,
  "meta_data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST /v3/rag/

​
Authentication

API Key (x-api-key) must be included in the header.

​
Request Body (JSON)

{
  "user_id": "string",
  "llm_credential_id": "string",
  "embedding_credential_id": "string",
  "vector_db_credential_id": "string",
  "description": "",
  "collection_name": "string",
  "llm_model": "string",
  "embedding_model": "string",
  "vector_store_provider": "string",
  "semantic_data_model": false,
  "meta_data": {}
}

​
Curl Request

curl -X POST "https://rag-dev.test.studio.lyzr.ai/v3/rag/" ^
-H "accept: application/json" ^
-H "content-type: application/json" ^
-H "x-api-key: sk-default-REDACTED" ^
-d "{
  \"user_id\": \"string\",
  \"llm_credential_id\": \"string\",
  \"embedding_credential_id\": \"string\",
  \"vector_db_credential_id\": \"string\",
  \"description\": \"\",
  \"collection_name\": \"string\",
  \"llm_model\": \"string\",
  \"embedding_model\": \"string\",
  \"vector_store_provider\": \"string\",
  \"semantic_data_model\": false,
  \"meta_data\": {}
}"

​
Response Example

{
  "id": "string",
  "user_id": "string",
  "llm_credential_id": "string",
  "embedding_credential_id": "string",
  "vector_db_credential_id": "string",
  "description": "",
  "collection_name": "string",
  "llm_model": "string",
  "embedding_model": "string",
  "vector_store_provider": "string",
  "semantic_data_model": false,
  "meta_data": {}
}

​
Error Response (422 Validation Error)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
user_id
string
required
​
llm_credential_id
string
required
​
embedding_credential_id
string
required
​
vector_db_credential_id
string
required
​
collection_name
string
required
​
llm_model
string
required
​
embedding_model
string
required
​
vector_store_provider
string
required
​
description
string
Example:

""

​
semantic_data_model
boolean
default:false
​
meta_data
object

Response

Successful Response

​
id
string
​
user_id
string
​
llm_credential_id
string
​
embedding_credential_id
string
​
vector_db_credential_id
string
​
description
string
​
collection_name
string
​
llm_model
string
​
embedding_model
string
​
vector_store_provider
string
​
semantic_data_model
boolean
​
meta_data
object